-
Notifications
You must be signed in to change notification settings - Fork 193
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Connectors wave 1 #4794
base: main
Are you sure you want to change the base?
Connectors wave 1 #4794
Conversation
👋 🤖 🤔 Hello, @mesellings! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
@mesellings this looks great! i really like the new structure! super useful, thank you! |
@mesellings Everyone who looked at this was at awe and I havent heard about anything worth correcting. Thank you so much and lets get this merged! Things that we have to watch from my perspective without any urgence:
|
? "badge--medium" | ||
: "badge--default" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[prettier] reported by reviewdog 🐶
? "badge--medium" | |
: "badge--default" | |
? "badge--medium" | |
: "badge--default" |
The preview environment relating to the commit 0956ddd has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4794/index.html |
@sbuettner This PR for the first wave of connectors work is now ready for review and merge 👍 @pepopowitz as requested, I've tagged you in for a review of the react component work on Camunda connectors Reviews should only concentrate on the restructure and main pages, as most other pages are untouched and will be covered in waves 2 and 3: Note: I haven't changed any file locations, so no redirects are required. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is basically an inspiration at this point -- amazing work getting this all together! I find it incredibly easy to navigate with this structure, and I love the cleanup of the titles as a quick win while you're in here. The connectors table especially is a nice upgrade.
I am sure others will have reviews more relevant to their areas of expertise, but from an organizational and basic information perspective, no notes from me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First off, this looks world class and I'm so thankful for you @mesellings and bringing this amazing experience to the Connectors team. They truly deserve it. 🧡
Comment: I thought the "Find a Camunda Connector" button would take me to the Camunda Marketplace, but I see that's another button.
Similar to my brand police comment on your dark mode PR, please ensure that you are following brand guidelines for the additional colors of labels and buttons (outbound and inbound labels prompted my brain to write this). This could be blocking.
Question: For the latest/popular content, who will commit to maintaining/updating that moving forward? I usually shy away from highlights like this because they can go stale.
Question: Did you mean to have a bolded link here?
Based on the other page, I assumed this would be a button.
Question: Is the > in the "Find a Camunda Connector >" button intentional? When do you add it and when do you not (the Marketplace button doesn't have a >, but pops you out of the docs).
Description
This PR contains the first wave of the Connector docs enhancements (https://github.com/camunda/developer-experience/issues/356).
Preview: https://preview.docs.camunda.cloud/pr-4794/docs/next/components/connectors/introduction-to-connectors/
Changes can be summarised as follows:
Reviewers: This work basically gives us a restructured menu and improves the main connector landing pages.
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).